home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 010a / org250sw.zip / ORG25.DOC < prev    next >
Text File  |  1991-12-02  |  54KB  |  1,212 lines
  1.  
  2.  
  3.           Documentation for ORG V:2.50        Copyright 90/91, M.H. Greve
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.                         ORG - Hard Disk Organizer Utility
  25.  
  26.                               Copyright (1990/1991)
  27.                              M.H. Greve + D. Rifkind
  28.                                All Rights Reserved
  29.  
  30.  
  31.  
  32.                         Distributed by:
  33.  
  34.                                Greve Computer Systems
  35.                                Aubrigstrasse 23
  36.                                CH 8804 AU
  37.                                Switzerland
  38.  
  39.  
  40.  
  41.                         Date:  December 2. 1991
  42.  
  43.  
  44.  
  45.  
  46.  
  47.           Documentation for ORG V:2.50        Copyright 90/91, M.H. Greve
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.                                      TABLE OF CONTENTS
  56.  
  57.  
  58.        1. Introduction                                               1
  59.        2. Getting Started - Installation                             2
  60.        3. About ORG                                                  4
  61.        4. The Configuration File                                     6
  62.        5. Command Line Switches                                     12
  63.        6. Limitations and Restrictions                              14
  64.        7. Acknowledgment                                            16
  65.  
  66.           Appendix A - Program Termination codes                    17
  67.           Appendix B - Error Messages                               17
  68.           Appendix C - Bugs                                         20
  69.           Appendix D - Technical Support                            21
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.                                        Page 1
  77.           
  78.           Documentation for ORG V:2.50        Copyright 90/91, M.H. Greve
  79.  
  80.  
  81.  
  82.  
  83.        1. INTRODUCTION
  84.        ---------------
  85.  
  86.           ORG is a Disk Organizer with a lot of features not found in
  87.           other similar programs. In addition to the traditional function
  88.           of un-fragmenting your disk, ORG will allow you to customize the
  89.           sequence in which files are placed on the disk, let you "lock"
  90.           (leave unchanged) any file or group of files, sort files in any
  91.           directory and delete temporary files on the fly, all in a single
  92.           pass.  Moreover, ORG does this as fast or faster than most
  93.           commercially available unfragmentation software. As you will
  94.           discover when you use the program:
  95.  
  96.           "ORG is the only Disk Organizer that truly deserves the name!"
  97.  
  98.  
  99.  
  100.           User Supported Software:
  101.           ------------------------
  102.           ORG is distributed as "Shareware" or "User Supported Software"
  103.           and is fully copyrighted.  You may have received a copy of ORG
  104.           free from a friend or a bulletin board or (for a nominal fee)
  105.           from a user's group or Shareware library.  However you received
  106.           ORG, you have a perfectly legal copy of the software.  You are
  107.           encouraged to make as many copies of the software and this
  108.           documentation as you like and distribute it to anyone you want,
  109.           as long as you do not charge a fee (other than to cover your own
  110.           distribution cost) and distribute only complete, unaltered copies
  111.           of the package, exactly as you received it.  If, after trying the
  112.           program for a few weeks, you find it useful and use it regularly,
  113.           you must register your copy by completing the form included in the
  114.           file "ORGREG.TXT" included in the distribution package.
  115.  
  116.           As a registered user you will receive a copy of the very latest
  117.           version of ORG and will be entitled to free support and will
  118.           receive upgrade notices and "bug fixes" as and when these become
  119.           available (for one full year from the date of purchase).
  120.  
  121.                                        Page 2
  122.           
  123.           Documentation for ORG V:2.50        Copyright 90/91, M.H. Greve
  124.  
  125.  
  126.  
  127.  
  128.        2. GETTING STARTED & INSTALLATION
  129.        ---------------------------------
  130.  
  131.           This section provides step by step instructions for running ORG
  132.           on any drive of a standard IBM PS/2, IBM PC, XT, AT, or any 100%
  133.           compatible running under MSDOS 2.10, or higher.
  134.  
  135.           If you are eager to run ORG right away, you need only read this
  136.           chapter now and can revert to the rest of the documentation for
  137.           a detailed description of the program's features and options
  138.           later.
  139.  
  140.           Note that you should never attempt to run ORG under a multi-
  141.           tasking operating system or OS-shell such as OS/2, Windows,
  142.           DesqView or Software Carousel, nor activate any "pop-up" program
  143.           (eg. SideKick) while the program is running.  ORG can recognize
  144.           some, but not all of the common multitasking programs and will
  145.           refuse to run if these are detected.
  146.  
  147.           1. Before you start, use the DOS DISKCOPY command to make a
  148.              duplicate of the distribution disk or, if you downloaded ORG
  149.              from a bulletin board, save the archive file onto two
  150.              diskettes and store one (the original) in a safe place.
  151.  
  152.           2. ORG does not require any special installation procedure. You
  153.              may run ORG from the backup floppy disk or from a subdirectory
  154.              on your hard disk.  If you wish to run the program from your
  155.              hard disk, copy the ORG.EXE program file to a subdirectory
  156.              which is included in your DOS PATH (see your DOS User's Guide)
  157.              and place the ORG.CFG file in the same directory or in the
  158.              root directory of the drive you wish to "unfragment".
  159.  
  160.           3. If you are running ORG for the first time, make sure you have
  161.              a current backup of the drive you wish to unfragment. You may
  162.              also wish to remove any resident utilities such as disk-cache
  163.              programs in order to avoid any potential conflicts.
  164.  
  165.           4. Run the DOS CHKDSK program on the drive and correct any errors
  166.              reported by it before proceeding further. If there are lost
  167.              clusters or cross-linked files on the disk, ORG will detect
  168.              this and refuse to run.
  169.  
  170.           5. Make the drive and/or directory containing ORG.EXE is the
  171.              current drive/directory. (Not necessary if ORG.CFG is in a
  172.              directory contained in your PATH).
  173.  
  174.  
  175.  
  176.                                        Page 3
  177.           
  178.           Documentation for ORG V:2.50        Copyright 90/91, M.H. Greve
  179.  
  180.  
  181.  
  182.  
  183.           6. Start ORG from the DOS prompt by typing:
  184.  
  185.                      ORG [d:] [/F] [/SIM] <Enter>
  186.  
  187.           The parameter d: is any valid drive specifier known to your system
  188.           (except a RAM disk or Network drive). ORG assumes the current
  189.           default drive if you omit the drive specifier.  Normally, ORG will
  190.           only unfragment the files without regard to their sequence on the
  191.           drive.  The /F parameter causes ORG to perform a complete disk
  192.           organization, placing files in the sequence specified in the
  193.           configuration file (see chapter 4:  The Configuration File).  In
  194.           default mode, ORG will normally optimize a 30MB drive in less than
  195.           two minutes.  The /SIM parameter (simulation mode) prevents ORG
  196.           from actually writing anything to disk.  As a first time user, you
  197.           may wish to use /SIM to uncover any potential conflicts with your
  198.           computer setup.
  199.  
  200.           ORG first reads the configuration file, evaluates the disk's drive
  201.           parameters, reads the FAT (File allocation Table) and directory
  202.           structure and, if necessary, sorts your files.  A window displays
  203.           ORG's progress through these steps.  ORG will pause and wait for
  204.           you to press the <Enter> key before proceeding to unfragment the
  205.           drive. If you did not copy the configuration file, ORG will warn
  206.           you of this and will use its own internal default settings.  You
  207.           may view these defaults and the configuration settings by pressing
  208.           the <F1> key.  If you decide you don't want to run ORG right now,
  209.           press <Esc>, and ORG will return you to the DOS environment.
  210.  
  211.           If you have used other unfragmentation programs before, the screen
  212.           layout with the large symbolic map of your disk will look
  213.           familiar.  To the right of the drive map,  ORG displays some of
  214.           the drive's parameters, a description of the symbols used, and
  215.           it's memory usage.  The %-completed and elapse-time displays in
  216.           the lower right corner provide an indication of ORG's progress.
  217.  
  218.           ORG can take anywhere from a few seconds to several minutes to
  219.           unfragment your disk.  Typically, it will take 1 to 2 minutes
  220.           to unfragment a 32MB partition with about 20MB of data.  You may
  221.           abort ORG at any time by simply pressing the <Esc> key.  The
  222.           integrity of your data is guaranteed if you exit in this manner.
  223.  
  224.           After optimization is completed, ORG will ask whether you wish to
  225.           re-boot the system.  Certain resident programs retain information
  226.           about the previous state of the disk.  Unless you are sure that
  227.           you have no such programs in your system, you should type "Y" to
  228.           allow ORG to initiate a system reset. (The re-boot query is not
  229.           displayed if you have used ORG on a removeable diskette).
  230.  
  231.                                        Page 4
  232.           
  233.           Documentation for ORG V:2.50        Copyright 90/91, M.H. Greve
  234.  
  235.  
  236.  
  237.  
  238.           Laptop users:
  239.           -------------
  240.           If you are running ORG on a laptop computer you may find the
  241.           display difficult to read.  This is because Laptops often emulate
  242.           color displays on the built in monochrome screen, making certain
  243.           colors hard to distinguish.  In such cases, re-start ORG using
  244.           the /L command line switch which forces ORG to use its monochrome
  245.           display settings irrespective of the type of video adaptor in-
  246.           stalled  (see chapter 5: Command Line Switches).
  247.  
  248.  
  249.           WARNING!
  250.           --------
  251.           NEVER re-boot or switch off the computer while ORG is running, as
  252.           this may cause loss of data. As a precaution, it is a good idea
  253.           to run ORG after you have made a backup of your hard disk,
  254.           particularly if you live in an area where power dips are common.
  255.  
  256.  
  257.  
  258.        3. ABOUT ORG
  259.        ------------
  260.  
  261.           You may run ORG on any valid drive in your system. This may be
  262.           a floppy, a hard disk, or a logical partition on your hard disk.
  263.           ORG should not be run on virtual (RAM) drives or Network drives
  264.           and will issue a warning if you specify one accidentally.  If
  265.           your computer is equipped with an EGA or VGA screen, ORG will
  266.           detect when the screen is set to 43/50 line and automatically use
  267.           the full screen display.  You may force ORG to display in either
  268.           25-line or 43/50-line mode by using the appropriate command line
  269.           switches (see Chapter 5).  If available, ORG will use expanded or
  270.           extended memory for its tables and buffers.  It requires the EMS
  271.           driver version 3.2 or above to access expanded memory.  Extended
  272.           memory requires the Microsoft XMS interface (HIMEM.SYS) to be
  273.           loaded in your system.
  274.  
  275.  
  276.           How ORG works:
  277.           --------------
  278.           After you start ORG, the program notes any command line options
  279.           and then searches for the configuration file ORG.CFG. ORG searches
  280.           for this file in the root directory of the target drive you
  281.           specified and then in the drive/directory from which ORG was
  282.           loaded.  ORG does not search your system's PATH.  This somewhat
  283.           restrictive search ensures good control over the configuration
  284.           file used and prevents ORG from accidentally loading an old
  285.  
  286.                                        Page 5
  287.           
  288.           Documentation for ORG V:2.50        Copyright 90/91, M.H. Greve
  289.  
  290.  
  291.  
  292.  
  293.           version that may be "visible" in your DOS PATH.  ORG.CFG contains
  294.           a list of special commands that allow you to control the way in
  295.           which ORG organizes the files on your disk. (Refer to chapter 4:
  296.           The Configuration File).
  297.  
  298.           ORG reads and analyses the parameters, directory structure and
  299.           FAT (File Allocation Table) of the drive and processes the
  300.           "delete" and "sort" command functions in memory, WITHOUT writing
  301.           to your hard disk.  ORG pauses at this stage and waits for you to
  302.           press the <Enter> key before beginning to organize the files.  If
  303.           you abort the program by pressing the <Esc> key at this stage, no
  304.           data on the disk will have been modified.
  305.  
  306.           By pressing the <F1> key you can view the configuration settings
  307.           before proceeding, to assure yourself that ORG will perform the
  308.           desired operations.
  309.  
  310.           Once ORG has started organizing the drive, you can still safely
  311.           interrupt the process at any time by pressing the <Esc> key. The
  312.           consistency and integrity of your files is guaranteed if you exit
  313.           ORG in this way, however ALL files which you flagged for deletion
  314.           will have been erased.
  315.  
  316.           WARNING: NEVER power off or re-boot your computer while ORG is
  317.                    running as this may cause loss of data integrity which
  318.                    can be very difficult to recover even with programs such
  319.                    as the Norton (TM) Utilites.
  320.  
  321.  
  322.           While ORG runs, it displays its progress on a disk-map in a window
  323.           of your screen.  In this map, each visible block corresponds to
  324.           one or more physical clusters on the drive.  The blocks that have
  325.           already been processed are highlighted.  Special symbols are used
  326.           to indicate locked or bad clusters.  The blocks being moved are
  327.           highlighted with an 'r' (read) or 'W' (write).  Note that ORG will
  328.           always move the largest possible contiguous block of clusters.  If
  329.           it can, it will move them to the final destination immediately. If
  330.           not, it will write them to the end of the disk temporarily.  This
  331.           process is very efficient since it ensures that each cluster on
  332.           the disk is never moved more than twice in a session.
  333.  
  334.           Frequently, ORG will detect that it already has the clusters it
  335.           needs in memory and will not re-read them.  This feature not only
  336.           saves time, but also prevents a lot of unnecessary "head-
  337.           thrashing" action.
  338.  
  339.           ORG updates the FAT and directory areas after writing each group
  340.  
  341.                                        Page 6
  342.           
  343.           Documentation for ORG V:2.50        Copyright 90/91, M.H. Greve
  344.  
  345.  
  346.  
  347.  
  348.           of blocks, ensuring disk integrity as far as technically possible.
  349.           In fact, loss of data is only possible during the relatively
  350.           short time when the directories and FAT are "out of synch".  This
  351.           is important, because ORG will retain data integrity at all other
  352.           times, even if a power dip were to occur during a "write" to the
  353.           data area.
  354.  
  355.           You will notice that ORG often appears to read or write to a
  356.           protected area or an area that has already been processed. This
  357.           is normal and is because each block usually represents several
  358.           clusters.
  359.  
  360.  
  361.           File order and sequence:
  362.           ------------------------
  363.           In its default mode ORG ignores file order and sequence on the
  364.           drive.  The algorithm used ensures that only a minimal number of
  365.           files will be moved to fully unfragment the drive and fill any
  366.           gaps between files.  By filling gaps ORG prevents the drive from
  367.           becoming rapidly fragmented again, since new files will be created
  368.           at the end of the existing contiguous data area.  When the /F
  369.           option is specified, ORG will order all files sequentially on the
  370.           drive:  It places all directories first on the drive and then
  371.           places remaining files in the sequence in which it encounters the
  372.           file name entries in the (sub)directories.  You may override or
  373.           modify these default settings by using the "sort" and "order"
  374.           commands in the configuration file, ORG.CFG (see Chapter 4: The
  375.           Configuration File).  When the /T option is used, files are sorted
  376.           in ascending order by time/date stamp, placing the newest, usually
  377.           most often changed files, last on the drive.  This ORGanization
  378.           method, unique to ORG proactively reduces the amount of fragmen-
  379.           tation on your drive.
  380.  
  381.           If you were to compare the result of organizing a disk under ORG
  382.           with that of other similar programs, you might find that some
  383.           programs will start organizing the disk over again.  This does not
  384.           mean that ORG failed to optimize your disk, it merely indicates
  385.           that there is more than one valid way (and no right way) to
  386.           organize directories and files on the disk.
  387.  
  388.  
  389.  
  390.        4. THE CONFIGURATION FILE
  391.        -------------------------
  392.           ORG uses a configuration file (default: ORG.CFG) which allows you
  393.           to customize the way your drive is ORGanized.  The configuration
  394.           file gives you full control over functions such as file sequence
  395.  
  396.                                        Page 7
  397.           
  398.           Documentation for ORG V:2.50        Copyright 90/91, M.H. Greve
  399.  
  400.  
  401.  
  402.  
  403.           on the drive, which files are to be deleted or "locked", ie. left
  404.           unaltered, by ORG.
  405.  
  406.           NOTE: The ORG.CFG file is not mandatory. If the file is not found,
  407.           ORG will use its own internal defaults (eg. lock system files on
  408.           your C: drive).  The configuration file simply provides an easy
  409.           way to customize ORG's behaviour on your system.
  410.  
  411.           ORG.CFG is an ASCII text file containing a series of special ORG
  412.           commands, much like a DOS batch file.  When you run ORG without
  413.           specifying a configuration file name, it searches for the ORG.CFG
  414.           file in the root directory of the target drive you selected when
  415.           you started the program and then in the drive/path where the
  416.           ORG.EXE program resides.  This restrictive search lets you keep a
  417.           customized configuration file for each drive in the root directory
  418.           of your hard disk.
  419.  
  420.           Under DOS versions earlier than 3.0, ORG will search for the
  421.           configuration file in the current default directory (CWD) instead
  422.           of in the directory from which ORG.EXE was loaded.
  423.  
  424.           ORG allows you to override the default name of the configuration
  425.           file (ORG.CFG), by simply specifying a file name of the form
  426.           "/@[d:][\pathspec\]filename" on the ORG command line. If you only
  427.           specify a filename, ORG will search the root directory of the
  428.           target drive and directory where the ORG.EXE program resides.
  429.           The configuration filespec must be immediately preceded by the
  430.           "@" sign.
  431.  
  432.           ORG.CFG uses a simple command structure similar to that used in
  433.           compiler MAKE files.  A sample configuration file (ORG.CFG) is
  434.           included in the ORG package. Each line in the configuration file
  435.           represents a command for ORG.  The command syntax is:
  436.  
  437.           <function> [\path\][filename]  [qualifier]  [#<comment>]
  438.  
  439.           Each command can take a qualifier that tells ORG which file
  440.           attributes are to be used to further specify the file(s). If you
  441.           specified the "sort" command (see below), the qualifier has a
  442.           different meaning: it indicates the type and sequence of the sort
  443.           keys.  Here are a few examples of valid commands:
  444.  
  445.           lock     *.* +s           # lock all system files
  446.           delete   \TEMP\*.back     # delete all .BACK files
  447.           sort     +n-t             # sort by filename, newest files first
  448.           order    *.EXE            # place all .EXE files first
  449.  
  450.  
  451.                                        Page 8
  452.           
  453.           Documentation for ORG V:2.50        Copyright 90/91, M.H. Greve
  454.  
  455.  
  456.  
  457.  
  458.           In the following you will find a detailed description of each
  459.           element of the configuration command:
  460.  
  461.           Commands:
  462.           ---------
  463.           lock -   prevents ORG from moving a specified file or group of
  464.                    files on the drive. This is essential to avoid moving
  465.                    files such as your DOS system files on the bootable
  466.                    partition of your disk.  It may also be necessary to
  467.                    lock the identification files used by certain copy-
  468.                    protected software. The "lock" function takes an optional
  469.                    attribute parameter.  ORG's default setting locks all
  470.                    "system" files.  You may disable this default setting
  471.                    using the /nod command line option.
  472.  
  473.  
  474.           sort -   allows you to sort the contents of the directory in
  475.                    ascending or descending order by filename, extension,
  476.                    date & time, or size. A sort is always performed on an
  477.                    entire directory; if a filename is given, it is ignored
  478.                    by ORG for the sort operation. The qualifier determines
  479.                    the type and sequence of the sort operation.
  480.  
  481.                    The command always places subdirectories first and then
  482.                    sorts directory names and filenames in two consecutive
  483.                    passes.
  484.  
  485.                    NOTE:  ORG processes directories and files in the order
  486.                    in which they are encountered.  Using the "sort" command
  487.                    thus affects the sequence in which ORG will place the
  488.                    files on the drive.  The "order" command described below
  489.                    allows you to override this sequence by specifying that
  490.                    certain files (or groups of files) be processed first.
  491.  
  492.           order -  allows you to force certain files, or groups of files
  493.                    (specified using DOS style wild selections) to be placed
  494.                    first on the disk.  If you use several "order" commands,
  495.                    they are processed in the sequence in which they appear
  496.                    in the configuration file.  If a group of files is
  497.                    specified, they are processed in sequence, by directory
  498.                    and in the sequence in which they appear in the directory
  499.                    structure.
  500.  
  501.                    Do not confuse this command with the "sort" command
  502.                    described above, which sorts directory and file names
  503.                    and thus implicitly determines the sequence of files.
  504.  
  505.  
  506.                                        Page 9
  507.           
  508.           Documentation for ORG V:2.50        Copyright 90/91, M.H. Greve
  509.  
  510.  
  511.  
  512.  
  513.                    As with the lock and delete options, you may specify one
  514.                    or more file attributes as qualifiers for the path\
  515.                    filename spec.  Note that ORG's default settings will
  516.                    place all directories first on the disk (behind the
  517.                    system files and/or the Volume identifier).  You may
  518.                    disable this default setting using the /nod command line
  519.                    option.
  520.  
  521.                    NOTE:  The 'order' command is only meaningful in "full"
  522.                    ORGanization mode.  (Chapter 5: Command Line Options).
  523.                    In QUICK mode or "New Files Last" mode, any 'order'
  524.                    commands are ignored.
  525.  
  526.  
  527.           delete - allows you to specify a file or group of files that you
  528.                    wish to delete from the drive.  For example, you might
  529.                    want to delete .BAK or .TMP files on your drive prior to
  530.                    unfragmenting. The default setting only allows ORG to
  531.                    delete normal files that is, files that have either no
  532.                    attributes or only the "archive" attribute set.  You may
  533.                    override this default by explicitly specifying one or
  534.                    more file attributes.
  535.  
  536.                    NOTE: Use this command with care, because if you
  537.                    accidentally delete a file with ORG, you will NOT be able
  538.                    to "un-erase" it any more later! For this reason, ORG
  539.                    will ignore a command to delete all files on the disk.
  540.                    ORG will also ignore requests to delete directories.
  541.  
  542.           The order in which commands are executed by ORG is fixed in the
  543.           program. Irrespective of where they appear in the configuration
  544.           file, commands are processed in the following sequence:
  545.  
  546.                 1.  lock
  547.                 2.  delete
  548.                 3.  sort
  549.                 4.  order
  550.  
  551.           Because any "lock" commands are processed first, they will take
  552.           precedence over "delete" commands that occur later, ie. ORG will
  553.           NOT delete files that have been "frozen" by a previous lock
  554.           command.
  555.  
  556.           If several similar commands occur, they are processed in the order
  557.           in which they appear in the configuration file, eg:
  558.  
  559.  
  560.  
  561.                                        Page 10
  562.  
  563.        Documentation for ORG V:2.50           Copyright 90/91, M.H. Greve
  564.  
  565.  
  566.  
  567.  
  568.             order  \command.com
  569.             order  *.COM
  570.             order  *.EXE
  571.  
  572.  
  573.           The Path/Filename Specifier:
  574.           ----------------------------
  575.           The second element in a command is the filename specifier. This
  576.           element follows MS-DOS conventions for directory and filenames.
  577.           You may specify any valid path (commands with invalid paths are
  578.           ignored; no error message is generated).
  579.  
  580.           The filename may contain the "wild-card" symbols '*' and '?'. The
  581.           filename may be omitted entirely if the pathname is terminated
  582.           by a backslash (\). ORG will then assume you specified all files
  583.           in this directory.  The following are some examples of valid
  584.           filename specifiers:
  585.  
  586.           delete   \brief\backup\   # delete all files in \BRIEF\BACKUP
  587.           order    \*.WK1           # place all Lotus 2.xx files first
  588.           delete   *.tmp  +r        # delete .TMP files, including read-only
  589.  
  590.           Note that the path\filename specifier is optional, however it may
  591.           only be omitted if you provide a qualifier on the line. This means
  592.           you must EITHER include a filename OR a qualifier (see below) and
  593.           may not omit both; a command containing a function only is
  594.           flagged as an error.
  595.  
  596.  
  597.           The Command Qualifier:
  598.           ----------------------
  599.           The qualifier has two functions.  For the "lock", "delete" and
  600.           "order" options it specifies the desired file attributes. For the
  601.           "sort" option, it defines the type, sequence and order (ascending
  602.           or descending) of sorting.  The qualifier is always optional.
  603.           Valid file attribute qualifiers are:
  604.  
  605.               +r        # Read-only files
  606.               +h        # Hidden files
  607.               +s        # System files
  608.               +d        # subdirectories
  609.               +a        # archive files
  610.  
  611.           A '+' (plus) or '-' (minus) sign must precede the attribute.  The
  612.           sign is used solely as a separator between consecutive attributes
  613.           and has no other meaning: it does NOT qualify the attribute. Both
  614.           signs are allowed for consistency with the sort qualifiers
  615.  
  616.                                        Page 11
  617.           
  618.        Documentation for ORG V:2.50           Copyright 90/91, M.H. Greve
  619.  
  620.  
  621.  
  622.  
  623.           described below and for possible future enhancement.  Attributes
  624.           may be combined on a command line. Some attributes are invalid
  625.           for certain commands and are ignored.  For example, the command
  626.           "delete *.* +d" will NOT cause subdirectories to be deleted.
  627.  
  628.           File attributes are of little or no significance in file sorting
  629.           operations.  The meaning of the qualifier is therefore quite
  630.           different for the "sort" option.  The four sort qualifiers
  631.           determine the type and order of the sort.  The following are valid
  632.           "sort" qualifiers:
  633.  
  634.               +n | -n   # sort by name
  635.               +e | -e   # sort by extension
  636.               +t | -t   # sort by date/time field
  637.               +s | -s   # sort by file size
  638.  
  639.           The sign preceding the qualifier acquires meaning in that it now
  640.           determines the direction of the sort, viz. ascending (+) or
  641.           descending (-) order.  You may specify multiple sort options; the
  642.           sequence of qualifiers determines the sort order.  Sorts are
  643.           performed on the entire directory, ie. any filenames you specify
  644.           are ignored. The following sort commands are identical:
  645.  
  646.               sort  \DOCS\*.DOC  +e-s
  647.               sort  \DOCS\*.*    +e-s
  648.               sort  \DOCS\       +e-s
  649.  
  650.           They each cause all files in the \DOCS subdirectory to be sorted
  651.           in ascending order by extension, placing the largest files first.
  652.  
  653.           Note that some combinations of sort qualifiers are mutually
  654.           exclusive: a sort by name, extension AND size is meaningless
  655.           because all files are uniquely defined by 'filename.ext'.
  656.           Similarly, subdirectories cannot be sorted by size.
  657.  
  658.  
  659.           Commenting the configuration file:
  660.           ---------------------------------
  661.           You may include comments in the configuration file to help you
  662.           document your commands.  Comments must be preceded by a '#' sign.
  663.           They may be placed after a command or on a separate line in the
  664.           configuration file.  If comments are placed after a command, you
  665.           must leave at least one blank space (or TAB) behind the command.
  666.  
  667.             order *.COM           # This is a comment following a command.
  668.             # Comments are also allowed on empty lines.
  669.  
  670.  
  671.                                        Page 12
  672.           
  673.        Documentation for ORG V:2.50           Copyright 90/91, M.H. Greve
  674.  
  675.  
  676.  
  677.  
  678.        5. COMMAND LINE SWITCHES
  679.        ------------------------
  680.  
  681.           ORG supports a small set of command line switches that control
  682.           ORG's global settings.  The complete command line is shown here:
  683.  
  684.           ORG [d:] [/A] [/E] [/Q] [/F] [/T] [/D] [/L] [/N] [/25|/50] [/NOD]
  685.               [/SIM] [/P | /X | /NOX] [/NODMA] [/@configfile] [/H]
  686.  
  687.           where:
  688.  
  689.           d:      is any valid drive specifier (A: - Z:).
  690.  
  691.           /A      Automatic mode: ORG runs without pausing for confirmation
  692.                   and exits to DOS without pausing at the end of the run.
  693.                   This option will also suppress the re-boot query message
  694.                   normally displayed by ORG at the end of each run.
  695.  
  696.           /E      Exit to DOS: At the end of each run, ORG will normally
  697.                   display a query message, asking if you wish to re-boot
  698.                   your system to reset any programs which may have retained
  699.                   information about the drive's previous state.  The /E
  700.                   option suppresses this message and causes ORG to exit to
  701.  
  702.                   DOS immediately.  (The re-boot query is not displayed if
  703.                   you have used ORG on a removeable diskette).
  704.  
  705.           /Q      Silent mode: disables sound.
  706.  
  707.           /F      Full ORG: This option causes ORG to sort all files on the
  708.                   drive in the sequence in which they are encountered in
  709.                   the directories. You can modify this sequence by either
  710.                   sorting the directory contents or explicitly specifying
  711.                   which files are to be placed on the drive. (See Chapter 4:
  712.                   The Configuration File).
  713.  
  714.           /T      Order by Time/Date: Places newest files LAST on the drive.
  715.                   When used alone, this option causes ORG to bias the file
  716.                   order by preferentially placing new files last on the
  717.                   drive, WITHOUT sacrificing speed.  To force full ordering
  718.                   by ascending Time/Date stamp, use both the '/T' and the
  719.                   '/F' options TOGETHER!
  720.  
  721.           /D      Directories only: ORGanizes directories only.
  722.  
  723.           /L      Laptop mode: forces a monochrome display on laptops that
  724.                   emulate color video adaptors.
  725.  
  726.                                        Page 13
  727.           
  728.        Documentation for ORG V:2.50           Copyright 90/91, M.H. Greve
  729.  
  730.  
  731.  
  732.  
  733.           /N      Causes path\file names of files being processed to be
  734.                   displayed.
  735.  
  736.           /25     Forces ORG to use a 25 line (text) display, irrespective
  737.                   of the initial display mode.  Use either /25 or /50.
  738.  
  739.           /50     Forces ORG to use the 43-line (EGA) or 50-line (VGA)
  740.                   display, irrespective of the initial display mode.  Use
  741.                   either /25 or /50.
  742.  
  743.           /SIM    Simulation mode: Selecting this option will allow you to
  744.                   test ORG on unknown systems without actually writing to
  745.                   the disk.  All other functionality remains unaffected.
  746.                   The message "Simulaton" is displayed in the lower right
  747.                   corner of the screen.
  748.                   This option can be very useful if you are trying to
  749.                   optimize your system and would like to add TSR programs
  750.                   which you think may work with ORG.
  751.  
  752.           /NOD    No defaults: turns off all default configuration options.
  753.                   ORG's default configuration locks system files and places
  754.                   directories first on the drive.  Disabling these defaults
  755.                   may cause certain otherwise unmovable system files to be
  756.                   moved and should only be used by experienced users. You
  757.                   will have to enter every option explicitly.
  758.                   The /NOD option may be used to make room for, or replace
  759.                   the system files on the bootable drive without recourse
  760.                   to the DOS SYS command.
  761.  
  762.                   WARNING:  Use the /NOD switch with great care,
  763.                   particularly on your bootable drive (C:).
  764.  
  765.           /P      Use exPAnded memory. Forces use of exPANded memory for
  766.                   buffers and the directory structure.
  767.  
  768.           /X      Use exTEnded memory. Forces use of exTENded memory for
  769.                   buffers and the directory structure.
  770.  
  771.           /NODMA  Enables direct data exchange between exPANded memory and
  772.                   the drive.  In default mode, ORG uses an intermediate
  773.                   buffer in conventional, DOS memory to transfer data
  774.                   between the disk and the exPANded memory area.  You may
  775.                   use the /nodma option to bypass this intermediate buffer,
  776.                   therby increasing unfragmentation speed when using
  777.                   exPANded memory.  However, you should NEVER use this
  778.                   option if your hardware make use of DMA (Direct Memory
  779.                   Access) data transfers (some SCSI disk controllers do!).
  780.  
  781.                                        Page 14
  782.           
  783.        Documentation for ORG V:2.50           Copyright 90/91, M.H. Greve
  784.  
  785.  
  786.  
  787.  
  788.                   DO NOT use /NODMA on machines with QEMM 6 installed.  QEMM
  789.                   will detect direct exPANded memory to disk data transfers
  790.                   and refuse to operate.  Also, on some old 8088 machines
  791.                   (IBM-PC/XT compatibles, direct memory transfer is known
  792.                   not to work correctly.
  793.  
  794.           /NOX    NO Extended/Expanded meory. Forces use of conventional
  795.                   (DOS) memory only.
  796.  
  797.           /@fname Used to specify an alternate path\filename to override
  798.                   the default configuration file name (ORG.CFG).
  799.                   Example: "ORG /@MYCONFIG.CFG"
  800.  
  801.           /H      Help: This switch overrides all others and simply causes
  802.                   a list of all available options to be displayed.
  803.  
  804.           Switches may be used alone or together (except /H) and may be
  805.           placed in any order on the command line.  The memory switches are
  806.           mutually exclusive, ie. only the first memory switch (/P /X /NOX)
  807.           used will be recignized and later ones ignored.  Blank separators
  808.           are optional except before the drive specifier.  You may use a
  809.           UNIX style dash '-' as a delimiter if you prefer. Thus any of the
  810.           following commands are valid:
  811.  
  812.                 ORG /F/A A: /SIM/NOX
  813.                 ORG C: -NOD -L
  814.                 ORG /A/L A:-NOD -@D:\MYDIR\MYCONFIG.CFG
  815.  
  816.  
  817.  
  818.        6. LIMITATIONS AND RESTRICTIONS
  819.        -------------------------------
  820.  
  821.           Operating System:
  822.           -----------------
  823.           ORG requires MS-DOS 2.1 or higher to run. It must NOT be run
  824.           under a multitasking Environment such as OS/2, Windows, DesqView
  825.           or Software Carousel because you can never be sure that other
  826.           programs are not using any of the files on the drive that ORG is
  827.           processing.  ORG will refuse to run under Windows or DesqView.
  828.           Popular memory management enhancers for 80386 processors such as
  829.           386MAX and QEMM are however compatible with ORG.
  830.  
  831.  
  832.           RAM- and Network drives:
  833.           ------------------------
  834.           ORG should not be run with RAM drives or Network drives.  If the
  835.  
  836.                                        Page 15
  837.           
  838.        Documentation for ORG V:2.50           Copyright 90/91, M.H. Greve
  839.  
  840.  
  841.  
  842.  
  843.           program detects either of these two devices, it will display an
  844.           appropriate error message.  ORG may however be run FROM either a
  845.           RAM or Network drive.
  846.  
  847.  
  848.           Large partition support:
  849.           ------------------------
  850.           ORG places no restrictions on the size of the drive and will
  851.           handle volumes greater than 32MB if you are using MS-DOS 4 or
  852.           higher or Compaq DOS 3.31.  The only limit is the amount of free
  853.           memory in your system: there must be enough room for ORG to keep
  854.           a complete copy of the directory structure resident in memory.
  855.           If extended or expanded memory is used, there are NO practical
  856.           restrictions to the partition size ORG can handle.  The following
  857.           theoretical limits apply:
  858.  
  859.             Maximum number of files on a logical drive...........32767
  860.               (includes the '.' and '..' directory entries)
  861.  
  862.             Maximum number of directories on a logical drive.....10922
  863.               (assumes a Root directory with 512 entries)
  864.  
  865.           The maximum number of files in any directory is limited by the
  866.           size of the the EMS or XMS page frame (ORG uses a 64K frame) when
  867.           using expanded or extended memory.  Owing to the paged addressing
  868.           using by the EMS interface, the maximum number of files ORG can
  869.           handle is actually less than 64KB when using expanded memory. If
  870.           conventional DOS memory if used, this restriction does not apply
  871.           since the entire directory table is retained entirely in memory.
  872.  
  873.             Maximum number of files per directory: with EMS...... 1535
  874.                                                    with XMS...... 2046
  875.  
  876.           If ORG finds a larger number of files in a directory, it will
  877.           display an error message with the name of the directory.  If you
  878.           get this message, you may first want to try and force ORG to use
  879.           extended or conventional memory, before attempting to re-arrange
  880.           (split up) the directory in question.
  881.  
  882.  
  883.           Compatibility:
  884.           --------------
  885.           Certain of ORG's options may change the order of files on your
  886.           disk and/or delete files without using DOS functions. Certain
  887.           disk utilities such as QDOS or the PC-TOOLS UNERASE or DOS's
  888.           FASTOPEN may retain information about the drive's previous state.
  889.           As a result, these programs may fail to operate correctly after
  890.  
  891.                                        Page 16
  892.           
  893.        Documentation for ORG V:2.50           Copyright 90/91, M.H. Greve
  894.  
  895.  
  896.  
  897.  
  898.           ORG has been run.  At the end of each run, ORG will query if you
  899.           want to re-boot the system in order to reset these programs'
  900.           buffers.  Unless you are quite sure that you are not using any
  901.           programs of this type, you should always allow ORG to re-boot the
  902.           computer.  Use the /e command line option to suppress ORG's
  903.           re-boot query message.  A System Reset is normally only required
  904.           for hard disks.  Thus, if you have used ORG on a removeable
  905.           diskette, the query message will not be displayed.
  906.  
  907.           If you are using utilities which maintain a reference file with
  908.           disk status information (eg. DOS 5 mirror), you will have to re-
  909.           run these programs to force them to rebuild the database.
  910.  
  911.           There are no other known incompatibilities with ORG.  Many
  912.           resident programs such as popular disk cache programs will not
  913.           interfere with ORG's operation, however you should avoid running
  914.           ORG in the presence of such resident utilites unless you
  915.           understand their function well and test them carefully first!
  916.           data transfer method by creating a special data transfer area in
  917.           low (conventional) memory.  Because of the multitude of available
  918.           EMS drivers, ORG cannot detect all potential conflicts.  If ORG's
  919.           performance seems slow, you may use the /NODMA option (to enable
  920.           direct EMS to disk transfer).
  921.  
  922.  
  923.  
  924.        7. ACKNOWLEDGMENT
  925.        -----------------
  926.  
  927.           The original idea for ORG is by David Rifkind, Newbury Park, CA.
  928.           Dave's "cluster-mover" concept is largely responsible for the
  929.           awesome speed with which ORG unfragments your hard disk! I am
  930.           very grateful to Dave for having donated me his code, without
  931.           which, I doubt I would have written ORG.
  932.  
  933.  
  934.  
  935.  
  936.                                        Page 17
  937.           
  938.        Documentation for ORG V:2.50           Copyright 90/91, M.H. Greve
  939.  
  940.  
  941.  
  942.  
  943.        APPENDIX A - PROGRAM TERMINATION CODES
  944.        --------------------------------------
  945.  
  946.           When ORG finishes a run, it sets the system ERRORLEVEL code
  947.           before exiting to DOS.  You may use these codes to determine
  948.           whether or not ORG completed the pass successfully and glean
  949.           some information about the cause of an abnormal termination,
  950.           for example if you are running ORG from a batch file.
  951.  
  952.           ORG generates the following ERRORLEVEL codes:
  953.  
  954.           ERRORLEVEL
  955.  
  956.               0  -  Normal program termination.
  957.  
  958.               1  -  Program aborted by user. Issued when you interrupt
  959.                     execution with the <ESC> key or exit in response to
  960.                     a warning error message.
  961.  
  962.               2  -  Bad option on ORG command line
  963.  
  964.              -1  -  All other errors and abnormal end conditions.
  965.  
  966.  
  967.  
  968.  
  969.        APPENDIX B - ERROR MESSAGES
  970.        ---------------------------
  971.  
  972.           If an error occurs, ORG will generate one of three types of error
  973.           messages.
  974.  
  975.           User Errors:
  976.           ------------
  977.  
  978.           These will warn you of operating problems that are usually fairly
  979.           easy to correct, such as the use of an invalid drive letter or
  980.           that there is not enough memory for ORG to run. The following is
  981.           a list of "User Errors". Most messages are self-explanatory.
  982.  
  983.            1. The boot record of this disk shows an invalid number of
  984.               sectors.
  985.  
  986.            2. The media descriptor in this disk's file allocation table does
  987.               not match the one in the boot record.
  988.  
  989.  
  990.  
  991.                                        Page 18
  992.           
  993.        Documentation for ORG V:2.50           Copyright 90/91, M.H. Greve
  994.  
  995.  
  996.  
  997.  
  998.            3. The File Allocation Table  contains bad link entries.
  999.  
  1000.            4. There are cross-linked clusters on this disk.
  1001.  
  1002.            5. There is not enough free space on this disk for ORG to work.
  1003.               You may need to delete some files.
  1004.  
  1005.            6. A cluster being used by a file is marked as available.
  1006.  
  1007.            7. A cluster being used by a file is marked as bad.
  1008.  
  1009.            8. Lost cluster(s) found on the drive.
  1010.  
  1011.            9. Cluster allocation error(s) found.
  1012.  
  1013.           10. A subdirectory contains a bad entry.
  1014.  
  1015.           11. There are too many options in the configuration file.  ORG
  1016.               is limited to 50 configuration options.
  1017.  
  1018.           12. The sector size of this disk is not 512 bytes. Under DOS
  1019.               version 2, ORG works only with 512-byte sectors.
  1020.  
  1021.           13. The boot record of this disk does not contain an MS-DOS
  1022.               signature.  This may not be a DOS disk.
  1023.  
  1024.           14. The specified drive is probably a RAMdrive or Network
  1025.               drive. ORG should only be used on local disks!
  1026.  
  1027.           15. The maximum number of directories (10,922) has been exceeded.
  1028.               Remove or merge directories and rerun ORG.
  1029.  
  1030.           16. The maximum number of files (32767) per drive has been
  1031.               exceeded. Delete some files and re-run ORG.
  1032.  
  1033.           17. The maximum number of files (xxxx) per directory has been
  1034.               exceeded in:
  1035.                         d:\DIRECT\
  1036.               Please re-arrange this directory before running ORG again.
  1037.  
  1038.           17. There is insufficient  DOS memory for ORG to run.  Remove
  1039.               resident programs to increase  memory.
  1040.  
  1041.           18. Request for Expanded Memory failed.  ORG requires at least
  1042.               16K LIM 3.2 Expanded Memory per megabyte of data on your disk
  1043.               to run.
  1044.  
  1045.  
  1046.                                        Page 18
  1047.           
  1048.        Documentation for ORG V:2.50           Copyright 90/91, M.H. Greve
  1049.  
  1050.  
  1051.  
  1052.  
  1053.           19. Request for XMS Extended Memory failed. ORG requires at least
  1054.               16K XMS Extended Memory per megabyte of data on your disk to
  1055.               run.
  1056.  
  1057.           20. Request for exPAnded Memory failed.  ORG may be able to use
  1058.               XMS or Conventional DOS Memory.
  1059.  
  1060.           21. Request for exTEnded Memory failed.  ORG may be able to use
  1061.               EMS or Conventional DOS Memory.
  1062.  
  1063.           22. "Request for exTEnded Memory failed. ORG may be able
  1064.                to use EMS or Conventional DOS Memory."
  1065.  
  1066.  
  1067.           Notes:
  1068.           (i)    Error 9 may indicate a serious problem with the drive.
  1069.                  Normally the problem can be fixed with a disk utility
  1070.                  such as the "Norton Disk Doctor" (TM).
  1071.  
  1072.           (ii)   Error 10 frequently occurs when you attempt to ORGanize
  1073.                  a RAM drive.
  1074.  
  1075.           (iii)  Errors 11 through 18 can usually be corrected with DOS's
  1076.                  CHKDSK program (see your MS-DOS User's Guide for a
  1077.                  detailed description of the CHKDSK command).
  1078.  
  1079.           (iv)   Errors 13 and 14 are warnings only. You may continue by
  1080.                  answering "Y" at the prompt, but do so at your own risk.
  1081.  
  1082.           (v)    Errors 20 and 21 occur when ORG attempts to allocate
  1083.                  Expanded or Extended memory.  If you are sure you have
  1084.                  sufficient Extended or Expanded memory for ORG to run
  1085.                  successfully but still get one of these error messages,
  1086.                  please contact the author. You may still be able to use
  1087.                  ORG by using the /nox option to force ORG to use
  1088.                  conventional DOS memory only.
  1089.  
  1090.  
  1091.  
  1092.           Disk Errors:
  1093.           ------------
  1094.  
  1095.           All Disk Errors reported by ORG (other than the trivial 'drive not
  1096.           ready' or 'diskette write protected') are serious errors that may
  1097.           indicate a deterioration of your hard disk.  They are always
  1098.           caused by a failure to read or write to a given sector on the
  1099.  
  1100.  
  1101.                                        Page 20
  1102.           
  1103.        Documentation for ORG V:2.50           Copyright 90/91, M.H. Greve
  1104.  
  1105.  
  1106.  
  1107.  
  1108.           disk. Depending on where and when they occurred, these errors may
  1109.           be recoverable.  If the bad sector is in the FAT (File Allocation
  1110.           Table) area of your disk, you risk losing data.
  1111.  
  1112.           If ORG reports a DISK ERROR, exit and run DOS's CHKDSK program to
  1113.           verify the error and then run a disk diagnostics/repair program
  1114.           to recover as much data as possible and try to restore the files
  1115.           from your backup.
  1116.  
  1117.           If ORG reports a "FATAL" error, it has failed during an attempt
  1118.           to update the FAT or root directory areas.  In this case, there
  1119.           is a serious risk of losing a significant amount of data.
  1120.           ORG displays the DOS internal error number (xxxx) and the sector
  1121.           number (nnnn) where the problem occured.  If possible, ORG
  1122.           displays a message corresponding to the error.  If a FAT write
  1123.           error occurred in FAT #2, it is very likely you will able to
  1124.           recover all your data.  The following messages may be reported by
  1125.           ORG in the event of a disk access error:
  1126.  
  1127.            1. "Recoverable error #xxxx,
  1128.                reading sector #nnnn in the data area."
  1129.  
  1130.            2. "Recoverable error #xxxx,
  1131.                writing sector #nnnn in the data area"
  1132.            3. "CRITICAL error #xxxx, reading sector #nnnn in FAT #m.
  1133.                The Disk may be unusable."
  1134.  
  1135.            4. "FATAL error #xxxx, writing sector #nnnn in FAT #m.
  1136.                Data may be destroyed!"
  1137.  
  1138.            5. "CRITICAL error #xxxx, reading sector #nnnn in the ROOT area.
  1139.                The Disk may be unusable."
  1140.  
  1141.  
  1142.            6. "FATAL error #xxxx, writing sector #nnnn in the Root area.
  1143.                Data may be destroyed!"
  1144.  
  1145.  
  1146.            Internal Errors:
  1147.            ----------------
  1148.  
  1149.            This last category of errors should NEVER occur. They are always
  1150.            associated with programming bugs and have been included solely
  1151.            to help with debugging. If you ever get an "Internal Error",
  1152.            please report it immediately and I will try and find the cause
  1153.            of the problem.
  1154.  
  1155.  
  1156.                                        Page 21
  1157.           
  1158.        Documentation for ORG V:2.50           Copyright 90/91, M.H. Greve
  1159.  
  1160.  
  1161.  
  1162.  
  1163.        APPENDIX C - BUGS
  1164.        -----------------
  1165.  
  1166.           Although ORG has been tested thoroughly, I cannot guarantee that
  1167.           it is truly free of bugs.  If you encounter what you believe to
  1168.           be a bug in ORG, you should try the following steps before calling
  1169.           or sending in a "Bug Report":
  1170.  
  1171.           Remove all TSR programs from your system, especially programs such
  1172.           as disk cache software or RAM drives or, better still, re-boot the
  1173.           computer from a "virgin" DOS diskette and try to run ORG again. If
  1174.           ORG runs in this environment but not in your normal DOS
  1175.           environment, try reconstructing the system under which ORG failed
  1176.           by adding drivers and TSR's one by one until the problem re-
  1177.           appears.  If you find the particular software which causes the
  1178.           trouble, please let me know about it, so that I can warn other
  1179.           users and try to find a "workaround" and send you an upgrade.
  1180.  
  1181.  
  1182.  
  1183.        APPENDIX D - TECHNICAL SUPPORT
  1184.        ------------------------------
  1185.  
  1186.           If the above approach does not work, please send a detailed report
  1187.           including a full description of your system to either Dave Rifkind
  1188.           or myself (addresses shown below) and we will try to help you find
  1189.           and solve the problem.
  1190.  
  1191.           NORTH AMERICA (U.S., CANADA, AND MEXICO):
  1192.                David Rifkind
  1193.                1800 West Hillcrest Drive, #287
  1194.                Newbury Park, CA  91320
  1195.                USA
  1196.  
  1197.           OUTSIDE NORTH AMERICA:
  1198.                Michael H. Greve
  1199.                Aubrigstrasse 23
  1200.                CH 8804 AU
  1201.                Switzerland
  1202.  
  1203.           Compuserve and BIX on-line support:
  1204.           -----------------------------------
  1205.  
  1206.           If you have access to Compuserve you can contact Dave Rifkind
  1207.           under the Compuserve ID: 72510,2214.
  1208.  
  1209.           If you have access to BIX, you can contact Mike Greve under the
  1210.           BIXname "mike123" or  Dave Rifkind under the BIXname "drifkind".
  1211.  
  1212.